spitoi2c.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef SPITOI2C_H
#define SPITOI2C_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"




#define SPITOI2C_CMD_WRITE                  0x00
#define SPITOI2C_CMD_READ                   0x01
#define SPITOI2C_CMD_READ_AFTER_WRITE       0x02
#define SPITOI2C_CMD_WRITE_AFTER_WRITE      0x03
#define SPITOI2C_CMD_READ_BUFFER            0x06
#define SPITOI2C_CMD_SPI_CONFIG             0x18
#define SPITOI2C_CMD_WRITE_REG              0x20
#define SPITOI2C_CMD_READ_REG               0x21
#define SPITOI2C_CMD_DEEP_POWER_DOWN        0x30
#define SPITOI2C_CMD_READ_VERSION           0xFE

#define SPITOI2C_REG_IO_CONFIG              0x00
#define SPITOI2C_REG_IO_STATE               0x01
#define SPITOI2C_REG_I2C_CLOCK              0x02
#define SPITOI2C_REG_I2C_TO                 0x03
#define SPITOI2C_REG_I2C_STAT               0x04
#define SPITOI2C_REG_I2C_ADR                0x05
 // spitoi2c_reg



#define SPITOI2C_I2C_CLOCK_375_KHZ          5
#define SPITOI2C_I2C_CLOCK_99_KHZ           19
#define SPITOI2C_I2C_CLOCK_7p4_KHZ          255
#define SPITOI2C_I2C_ADDR_127               0xFE
#define SPITOI2C_I2C_TO_DISABLE             0x00

#define SPITOI2C_I2C_STATUS_SUCCESS         0xF0
#define SPITOI2C_I2C_STATUS_TARGET_NACK     0xF1
#define SPITOI2C_I2C_STATUS_WRITE_NACK      0xF2
#define SPITOI2C_I2C_STATUS_BUSY            0xF3
#define SPITOI2C_I2C_STATUS_TIMEOUT         0xF8
#define SPITOI2C_I2C_STATUS_DATA_COUNT      0xF9

#define SPITOI2C_TIMEOUT_MS                 3000

#define SPITOI2C_NO_PIN_MASK                0x00
#define SPITOI2C_PIN_0_MASK                 0x01
#define SPITOI2C_PIN_1_MASK                 0x02
#define SPITOI2C_PIN_2_MASK                 0x04
#define SPITOI2C_PIN_3_MASK                 0x08
#define SPITOI2C_PIN_4_MASK                 0x10
#define SPITOI2C_ALL_PINS_MASK              0x1F
#define SPITOI2C_ALL_OUT_PINS_MASK          0x0F

#define SPITOI2C_PIN_DIR_INPUT              0x00
#define SPITOI2C_PIN_DIR_OUTPUT_PP          0x02
#define SPITOI2C_PIN_DIR_OUTPUT_OD          0x03
#define SPITOI2C_PIN_DIR_MASK               0x03

#define SPITOI2C_I2C_READ_BIT               0x01

#define SPITOI2C_SPI_CONFIG_LSB_FIRST       0x81
#define SPITOI2C_SPI_CONFIG_MSB_FIRST       0x42

#define SPITOI2C_DEEP_PDOWN_BYTE_0          0x5A
#define SPITOI2C_DEEP_PDOWN_BYTE_1          0xA5
 // spitoi2c_set



#define SPITOI2C_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // spitoi2c_map // spitoi2c

typedef struct
{
    // Output pins
    digital_out_t mosi;             
    digital_out_t sck;              
    digital_out_t cs;               
    digital_out_t rst;              
 
    // Input pins
    digital_in_t miso;              
    digital_in_t int_pin;           
 
} spitoi2c_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
 
    // Additional gpio pins
    pin_name_t rst;                 
    pin_name_t int_pin;             
 
} spitoi2c_cfg_t;

typedef enum
{
    SPITOI2C_OK = 0,
    SPITOI2C_ERROR = -1
 
} spitoi2c_return_value_t;


void spitoi2c_cfg_setup ( spitoi2c_cfg_t *cfg );

err_t spitoi2c_init ( spitoi2c_t *ctx, spitoi2c_cfg_t *cfg );

err_t spitoi2c_default_cfg ( spitoi2c_t *ctx );

err_t spitoi2c_gpio_write ( spitoi2c_t *ctx, uint8_t gpio_data );

err_t spitoi2c_gpio_read ( spitoi2c_t *ctx, uint8_t *gpio_data );

err_t spitoi2c_gpio_config ( spitoi2c_t *ctx, uint8_t direction, uint8_t pin_mask );

err_t spitoi2c_read_i2c_status ( spitoi2c_t *ctx, uint8_t *i2c_stat );

err_t spitoi2c_i2c_write ( spitoi2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len );

err_t spitoi2c_i2c_read ( spitoi2c_t *ctx, uint8_t slave_addr, uint8_t *data_out, uint8_t len );

err_t spitoi2c_i2c_read_after_write ( spitoi2c_t *ctx, uint8_t slave_addr, 
                                      uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len );

err_t spitoi2c_i2c_write_after_write ( spitoi2c_t *ctx, uint8_t slave_addr, 
                                       uint8_t *data_in1, uint8_t in1_len, uint8_t *data_in2, uint8_t in2_len );

void spitoi2c_read_buffer ( spitoi2c_t *ctx, uint8_t *data_out, uint8_t len );

err_t spitoi2c_set_spi_config ( spitoi2c_t *ctx, uint8_t spi_cfg );

err_t spitoi2c_write_register ( spitoi2c_t *ctx, uint8_t reg, uint8_t data_in );

err_t spitoi2c_read_register ( spitoi2c_t *ctx, uint8_t reg, uint8_t *data_out );

void spitoi2c_deep_power_down ( spitoi2c_t *ctx );

void spitoi2c_wake_up ( spitoi2c_t *ctx );

err_t spitoi2c_read_version ( spitoi2c_t *ctx, uint8_t *version );

void spitoi2c_enable_device ( spitoi2c_t *ctx );

void spitoi2c_disable_device ( spitoi2c_t *ctx );

uint8_t spitoi2c_get_int_pin ( spitoi2c_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SPITOI2C_H
 // spitoi2c
 
// ------------------------------------------------------------------------ END